home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / SLGetSpoolerState.z / SLGetSpoolerState
Text File  |  1998-10-30  |  7KB  |  132 lines
  1.  
  2.  
  3.  
  4. SSSSLLLLGGGGeeeettttSSSSppppoooooooolllleeeerrrrSSSSttttaaaatttteeee((((3333))))             IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo              SSSSLLLLGGGGeeeettttSSSSppppoooooooolllleeeerrrrSSSSttttaaaatttteeee((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SLGetSpoolerState, SLSetSpoolerState - gets/sets the spooling system
  10.      printing and queueing state
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssppppoooooooollll....hhhh>>>>
  14.  
  15.      iiiinnnntttt SSSSLLLLGGGGeeeettttSSSSppppoooooooolllleeeerrrrSSSSttttaaaatttteeee((((ccccoooonnnnsssstttt cccchhhhaaaarrrr ****pppprrrriiiinnnntttteeeerrrr,,,, iiiinnnntttt ffffuuuunnnnccccttttiiiioooonnnn,,,,
  16.                            iiiinnnntttt ****ssssttttaaaatttteeeepppp))));;;;
  17.      iiiinnnntttt SSSSLLLLSSSSeeeettttSSSSppppoooooooolllleeeerrrrSSSSttttaaaatttteeee((((ccccoooonnnnsssstttt cccchhhhaaaarrrr ****pppprrrriiiinnnntttteeeerrrr,,,, iiiinnnntttt ffffuuuunnnnccccttttiiiioooonnnn,,,,
  18.                            iiiinnnntttt ssssttttaaaatttteeee))));;;;
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      Each printer (or class of printers in System V) is associated with a
  22.      printer queue. This queue holds the jobs that have been submitted for
  23.      printing. The jobs are fed one by one to the printer.  The queue can be
  24.      viewed as having a gate at each end. The gate at the front end of the
  25.      queue controls whether jobs are sent to the printer. The gate at the back
  26.      of the queue controls whether jobs are accepted into the queue for
  27.      printing.  The _S_L_S_e_t_S_p_o_o_l_e_r_S_t_a_t_e function controls the state of each of
  28.      these queue gates. The _S_L_G_e_t_S_p_o_o_l_e_r_S_t_a_t_e function reports the current
  29.      state of each gate.
  30.  
  31.      _p_r_i_n_t_e_r        Specifies the printer whose spooler state is to be set or
  32.                     reported. If _p_r_i_n_t_e_r is specified as NNNNUUUULLLLLLLL, the default
  33.                     printer is used.
  34.  
  35.      _f_u_n_c_t_i_o_n       Specifies which gate or spooling function is to be set or
  36.                     reported. If the value is SSSSLLLL____PPPPRRRRIIIINNNNTTTTIIIINNNNGGGG, the state of the
  37.                     printing gate is set or reported. If the value is
  38.                     SSSSLLLL____QQQQUUUUEEEEUUUUEEEEIIIINNNNGGGG, the state of the queue entry gate is set or
  39.                     reported.
  40.  
  41.      _s_t_a_t_e          This value indicates the state to set for the spooling
  42.                     function specified by the _f_u_n_c_t_i_o_n parameter. The value is
  43.                     one of SSSSLLLL____EEEENNNNAAAABBBBLLLLEEEEDDDD or SSSSLLLL____DDDDIIIISSSSAAAABBBBLLLLEEEEDDDD.
  44.  
  45.      _s_t_a_t_e_p         This value indicates the current state of the spooling
  46.                     function specified by the _f_u_n_c_t_i_o_n parameter. The value is
  47.                     one of SSSSLLLL____EEEENNNNAAAABBBBLLLLEEEEDDDD or SSSSLLLL____DDDDIIIISSSSAAAABBBBLLLLEEEEDDDD.
  48.  
  49. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  50.      0 is returned if execution was successful. -1 is returned and _S_L_e_r_r_n_o is
  51.      set if an execution error has occurred.
  52.  
  53. EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
  54.      _S_L_G_e_t_S_p_o_o_l_e_r_S_t_a_t_e and _S_L_S_e_t_S_p_o_o_l_e_r_S_t_a_t_e will fail under the following
  55.      general circumstances.
  56.  
  57.  
  58.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. SSSSLLLLGGGGeeeettttSSSSppppoooooooolllleeeerrrrSSSSttttaaaatttteeee((((3333))))             IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo              SSSSLLLLGGGGeeeettttSSSSppppoooooooolllleeeerrrrSSSSttttaaaatttteeee((((3333))))
  70.  
  71.  
  72.  
  73.      SL_ERR_FIND_SPOOLER      An error occurred while attempting to determine
  74.                               the available printer spooling systems.
  75.  
  76.      SL_ERR_NO_SPOOLERS       There are no printer spooling systems available.
  77.  
  78.  
  79.      SL_ERR_NO_DEF_PRINTER    There is no default printer registered with the
  80.                               printer spooling system.
  81.  
  82.      SL_ERR_SPOOLER_ERROR     A printer spooling system error has occurred.
  83.  
  84.      SL_ERR_BAD_FUNCTION      An invalid printer spooling function has been
  85.                               specified.
  86.  
  87.      SL_ERR_BAD_PRINTER_NAME  The printer name specified is either an empty
  88.                               string (""), or a string consisting entirely of
  89.                               whitespace.
  90.  
  91.      In addition to the general failures above, _S_L_G_e_t_S_p_o_o_l_e_r_S_t_a_t_e will also
  92.      fail under the following circumstances.
  93.  
  94.      SL_ERR_NO_STATE          The printer spooling state could not be
  95.                               determined.
  96.  
  97.      In addition to the general failures above, _S_L_S_e_t_S_p_o_o_l_e_r_S_t_a_t_e will also
  98.      fail under the following circumstances.
  99.  
  100.      SL_ERR_BAD_STATE         An invalid printer spooling function state has
  101.                               been specified.
  102.  
  103.      SL_ERR_PRIVILEGE         Super-user privilege is required to execute this
  104.                               function. System V permits certain functions to
  105.                               be executed with "lp" account privileges.
  106.  
  107. NNNNOOOOTTTTEEEESSSS
  108.      1.   If BSD is the current spooling system, super-user privilege is
  109.           required to successfully call the _S_L_S_e_t_S_p_o_o_l_e_r_S_t_a_t_e function. If the
  110.           current spooling system is System V, the queueing state can be
  111.           changed if the caller's uid is either super-user or _l_p, and the
  112.           printing state can be changed if the caller's euid is either super-
  113.           user or _l_p.
  114.  
  115.      2.   Under the System V spooling system, it is an error to attempt to
  116.           disable printing (SSSSLLLL____PPPPRRRRIIIINNNNTTTTIIIINNNNGGGG function) for a printer class.
  117.  
  118. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  119.      SLPerror(3), libspool(3), accept(1), reject(1), enable(1), disable(1),
  120.      lpc(1M)
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.